A semantic search engine for source code https://bitshift.benkurtovic.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 1.4 KiB

10 vuotta sitten
10 vuotta sitten
12345678910111213141516171819202122232425262728293031323334353637383940
  1. bitshift
  2. ========
  3. bitshift is a semantic search engine for source code developed by Benjamin
  4. Attal, Ben Kurtovic, and Severyn Kozak.
  5. Branches
  6. --------
  7. - `master`: working, tested, version-numbered code - no direct commits; should
  8. only accept merges from `develop` when ready to release
  9. - `develop`: integration branch with unreleased but mostly functional code -
  10. direct commits allowed but should be minor
  11. - `feature/*`: individual components of the project with untested, likely
  12. horribly broken code - branch off from and merge into `develop` when done
  13. Style
  14. -----
  15. bitshift uses [SASS][SASS] for styling; compile the stylesheets to CSS with
  16. `sass --watch static/sass/:static/css`.
  17. Documentation
  18. -------------
  19. To build documentation, run `make html` from the `docs` subdirectory. You can
  20. then browse from `docs/build/html/index.html`.
  21. To automatically update the API documentation structure (necessary when adding
  22. new modules or packages, but *not* when adding functions or changing
  23. docstrings), run `sphinx-apidoc -fo docs/source/api bitshift` from the project
  24. root. Note that this will revert any custom changes made to the files in
  25. `docs/source/api`, so you might want to update them by hand instead.
  26. [SASS]: http://sass-lang.com/guide
  27. Releasing
  28. ---------
  29. - Update `__version__` in `bitshift/__init__.py`, `version` in `setup.py`, and
  30. `version` and `release` in `docs/conf.py`.