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.
 
 
 
 
 
 
Severyn Kozak 627c848f20 Add tested indexer. пре 10 година
bitshift Add tested indexer. пре 10 година
docs Add Codelet, crawler dependencies to setup. пре 10 година
static Add assets/config module, SASS files, templates. пре 10 година
templates Add assets/config module, SASS files, templates. пре 10 година
.gitignore Adding basic sphinx documentation. пре 10 година
LICENSE Fix names in license. пре 10 година
README.md Credits. пре 10 година
app.py CREATE THE THINGS пре 10 година
setup.py Add Codelet, crawler dependencies to setup. пре 10 година

README.md

bitshift

bitshift is a semantic search engine for source code developed by Benjamin Attal, Ben Kurtovic, and Severyn Kozak.

Branches

  • master: working, tested, version-numbered code - no direct commits; should only accept merges from develop when ready to release
  • develop: integration branch with unreleased but mostly functional code - direct commits allowed but should be minor
  • feature/*: individual components of the project with untested, likely horribly broken code - branch off from and merge into develop when done

Style

bitshift uses SASS for styling; compile the stylesheets to CSS with sass --watch static/sass/:static/css.

Documentation

To build documentation, run make html from the docs subdirectory. You can then browse from docs/build/html/index.html.

To automatically update the API documentation structure (necessary when adding new modules or packages, but not when adding functions or changing docstrings), run sphinx-apidoc -fo docs/source/api bitshift from the project root. Note that this will revert any custom changes made to the files in docs/source/api, so you might want to update them by hand instead.