Group: LibreDWG

From LibrePlanet
Jump to: navigation, search
(First update of LibreDWG hackers' wiki)
 
(Hacking and submitting changes)
Line 45: Line 45:
  
 
=Hacking and submitting changes=
 
=Hacking and submitting changes=
 +
 +
You are welcome to get your hands dirty and put down some code. Although, you should be aware of some details:
 +
 +
*Try to follow the [http://www.gnu.org/prep/standards_toc.html GNU Coding Standards].
 +
*Be aware that the copyright over your work will be assinged to the Free Software Foundation. We have decided this because the FSF will enforce the GPL for the program if someone violates it, and will act juridically if necessary. Although, you still get the credit for your work.
 +
 +
Please be sure to work on the latest revision. Run ''git pull'' from time to time and before generating patches.
 +
 +
After your changes are done and well tested, generate a patch (check git documentation if you don't know how to do it) and submit it to the [https://savannah.gnu.org/patch/?func=additem&group=libredwg patch tracker].
  
 
=Git push access=
 
=Git push access=

Revision as of 20:42, 12 January 2010

This is the GNU LibreDWG hackers' wiki. For general information about the project, please check the official website.

This wiki is mainly intended to help developers or advanced users checkout the latest source code, compile, test, modify and submit changes to LibreDWG. Feel free to contribute to this page. If you are creating a new page, please put it under the LibreDWG tree, eg. http://groups.fsf.org/wiki/LibreDWG/Testing.

LibreDWG's source code and administrative tools (mailing lists, bug, patch and support trackers) are hosted at Savannah: [1].

There is no binary release yet. Therefore, anyone who wants to test LibreDWG will have to checkout and compile.

Checking out the latest source code

The source code is hosted in a git repository. Check out git's website if you don't know what git is. To check out as an anonymous user:

git clone git://git.sv.gnu.org/libredwg.git

Compiling

You need basic development tools and pslib to compile libredwg. In debian-like distributions, install the build-essential and pslib-dev packages. Cd to the libredwg folder created by git, and type:

make
sudo make install
make check

If you get any errors, please contact us through the mailing list.

Testing

LibreDWG comes with several examples (under the examples folder) that can be used for testing purposes. The most advanced example is testSVG.

cd examples
./testSVG yourdwgfile.dwg > yourconverteddwgfile.svg

If you get any errors (specially segfaults) and want to submit a bug, please attach a file with your output. To redirect all output, including stderr to a file:

./testSVG yourdwgfile.dwg 2&> test.out

If possible, add a link to the tested DWG file to the submission. We can't do much if we can't access the file. Don't attach DWG files to the submission, specially if you don't have copy rights over them.

Hacking and submitting changes

You are welcome to get your hands dirty and put down some code. Although, you should be aware of some details:

  • Try to follow the GNU Coding Standards.
  • Be aware that the copyright over your work will be assinged to the Free Software Foundation. We have decided this because the FSF will enforce the GPL for the program if someone violates it, and will act juridically if necessary. Although, you still get the credit for your work.

Please be sure to work on the latest revision. Run git pull from time to time and before generating patches.

After your changes are done and well tested, generate a patch (check git documentation if you don't know how to do it) and submit it to the patch tracker.

Git push access