A semantic search engine for source code https://bitshift.benkurtovic.com/
Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 
 
 
 
 
Severyn Kozak 627c848f20 Add tested indexer. há 10 anos
bitshift Add tested indexer. há 10 anos
docs Add Codelet, crawler dependencies to setup. há 10 anos
static Add assets/config module, SASS files, templates. há 10 anos
templates Add assets/config module, SASS files, templates. há 10 anos
.gitignore Adding basic sphinx documentation. há 10 anos
LICENSE Fix names in license. há 10 anos
README.md Credits. há 10 anos
app.py CREATE THE THINGS há 10 anos
setup.py Add Codelet, crawler dependencies to setup. há 10 anos

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.