Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
66 lines (42 sloc) 1.64 KB

General remarks

Contributing

You can contribute to the public repository and raise issues there. Please also make sure to follow the code of conduct and to read the contributing notes. Make sure to also read about :ref:`testing` before you open a pull request.

Install dev version

Clone and install this repository as

git clone --recurse-submodules -j8 git@github.com:benmaier/netwulf.git
make

Note that make per default lets pip install a development version of the repository.

Update JS base

The JS base code in /netwulf/js/ is a fork of Ulf Aslak's interactive web app. If this repository is updated, change to /netwulf/js/, then do

git fetch upstream
git merge upstream/master
git commit -m "merged"
git push

Upload to PyPI

If you want to upload to PyPI, first convert the new README.md to README.rst

make readme

It will give you warnings about bad .rst-syntax. Fix those errors in README.rst. Then wrap the whole thing

make pypi

It will probably give you more warnings about .rst-syntax. Fix those until the warnings disappear. Then do

make upload
You can’t perform that action at this time.