Difference between revisions of "Getting started"

From vice-emu
Jump to: navigation, search
m
m (downloading a nightly build)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
[[File:wewantyou.gif|right|392px]]
 +
 
The purpose of this page is to give a quick introduction to people who want to support the development of VICE in one way or another.
 
The purpose of this page is to give a quick introduction to people who want to support the development of VICE in one way or another.
  
 
<big>New Developers [[Wanted]]</big>
 
<big>New Developers [[Wanted]]</big>
 +
 +
=== downloading a nightly build ===
 +
 +
Get a fresh Windows build [http://vice.pokefinder.org here]. Unofficial nightly builds for debian can be found [http://software.opensuse.org/download.html?project=home%3Astrik&package=vice here].
  
 
=== reporting bugs ===
 
=== reporting bugs ===
  
 
For various reasons we prefer bugs being reported only through the bug tracker on sourceforge. This allows us to manage them within reasonable resources. Unfortunately you will have to create yourself an account on sourceforge to do this - we are sorry for that, but we can't handle all the spam that would quickly appear when we remove this requirement.
 
For various reasons we prefer bugs being reported only through the bug tracker on sourceforge. This allows us to manage them within reasonable resources. Unfortunately you will have to create yourself an account on sourceforge to do this - we are sorry for that, but we can't handle all the spam that would quickly appear when we remove this requirement.
 +
Before reporting bugs you may want to have a look at the list of [[Todo#Known_Issues|known issues]]
  
 
* [https://sourceforge.net/tracker/?limit=100&func=&group_id=223021&atid=1057617&assignee=&status=4&category=&artgroup=&keyword=&submitter=&artifact_id=&assignee=&status=1&category=&artgroup=&submitter=&keyword=&artifact_id=&submit=Filter&mass_category=&mass_priority=&mass_resolution=&mass_assignee=&mass_artgroup=&mass_status=&mass_cannedresponse= Tracker: open Bugs]
 
* [https://sourceforge.net/tracker/?limit=100&func=&group_id=223021&atid=1057617&assignee=&status=4&category=&artgroup=&keyword=&submitter=&artifact_id=&assignee=&status=1&category=&artgroup=&submitter=&keyword=&artifact_id=&submit=Filter&mass_category=&mass_priority=&mass_resolution=&mass_assignee=&mass_artgroup=&mass_status=&mass_cannedresponse= Tracker: open Bugs]
Line 21: Line 28:
 
: <tt><pre>svn checkout --username=YOURUSERNAME svn+ssh://YOURUSERNAME@svn.code.sf.net/p/vice-emu/code/testprogs testprogs</pre></tt>
 
: <tt><pre>svn checkout --username=YOURUSERNAME svn+ssh://YOURUSERNAME@svn.code.sf.net/p/vice-emu/code/testprogs testprogs</pre></tt>
  
=== building VICE ===
+
=== building VICE from source ===
  
 
VICE can be build on various setups and operating systems - please look in the VICE source tree at [https://sourceforge.net/p/vice-emu/code/HEAD/tree/trunk/vice/doc/building/ vice/doc/building/] for detailed instructions. (and please let us know if these don't work for you)
 
VICE can be build on various setups and operating systems - please look in the VICE source tree at [https://sourceforge.net/p/vice-emu/code/HEAD/tree/trunk/vice/doc/building/ vice/doc/building/] for detailed instructions. (and please let us know if these don't work for you)
Line 27: Line 34:
 
=== Documentation for Developers ===
 
=== Documentation for Developers ===
  
* [[Resource_and_Cmdline_checking]] - Tracks and documents all Resources and Command line options
+
* [[Todo]] - list of known issues, and more general TODO lists
 +
* VICE [https://sourceforge.net/p/vice-emu/code/HEAD/tree/trunk/vice/doc/coding-guidelines.txt coding guidelines]
 +
 
 +
for a full list of existing documentation look [[Main_Page#Development|here]].
 +
 
 +
=== submit patches ===
 +
 
 +
We prefer patches being submitted via the Sourceforge Tracker:
 +
 
 +
in the toplevel VICE directory type
 +
<pre>svn diff > mypatch.diff</pre>
 +
and attach the resulting file.
 +
 
 +
Please make sure to respect the [https://sourceforge.net/p/vice-emu/code/HEAD/tree/trunk/vice/doc/coding-guidelines.txt coding guidelines], and create one patch per issue - giant "all in one" patches are hard to manage properly and may be rejected.
 +
 
 +
* [https://sourceforge.net/tracker/?limit=100&func=&group_id=223021&atid=1057619&assignee=&status=&category=&artgroup=&keyword=&submitter=&artifact_id=&assignee=&status=1&category=&artgroup=&submitter=&keyword=&artifact_id=&submit=Filter&mass_category=&mass_priority=&mass_resolution=&mass_assignee=&mass_artgroup=&mass_status=&mass_cannedresponse= Tracker: open Patches]
  
 
=== contact the developers ===
 
=== contact the developers ===

Latest revision as of 03:05, 22 May 2018

Wewantyou.gif

The purpose of this page is to give a quick introduction to people who want to support the development of VICE in one way or another.

New Developers Wanted

downloading a nightly build

Get a fresh Windows build here. Unofficial nightly builds for debian can be found here.

reporting bugs

For various reasons we prefer bugs being reported only through the bug tracker on sourceforge. This allows us to manage them within reasonable resources. Unfortunately you will have to create yourself an account on sourceforge to do this - we are sorry for that, but we can't handle all the spam that would quickly appear when we remove this requirement. Before reporting bugs you may want to have a look at the list of known issues

checking out the SVN repository

  • check out the current VICE source repository:
svn checkout svn://svn.code.sf.net/p/vice-emu/code/trunk trunk
or when you already have an account with write access:
svn checkout --username=YOURUSERNAME svn+ssh://YOURUSERNAME@svn.code.sf.net/p/vice-emu/code/trunk trunk
  • check out the current VICE test programs repository:
svn checkout svn://svn.code.sf.net/p/vice-emu/code/trunk trunk
or when you already have an account with write access:
svn checkout --username=YOURUSERNAME svn+ssh://YOURUSERNAME@svn.code.sf.net/p/vice-emu/code/testprogs testprogs

building VICE from source

VICE can be build on various setups and operating systems - please look in the VICE source tree at vice/doc/building/ for detailed instructions. (and please let us know if these don't work for you)

Documentation for Developers

for a full list of existing documentation look here.

submit patches

We prefer patches being submitted via the Sourceforge Tracker:

in the toplevel VICE directory type

svn diff > mypatch.diff

and attach the resulting file.

Please make sure to respect the coding guidelines, and create one patch per issue - giant "all in one" patches are hard to manage properly and may be rejected.

contact the developers