A semantic search engine for source code https://bitshift.benkurtovic.com/

Benjamin Attal 306875dae7 Make Parser implement runnable so parsing tasks can be started in separate threads. Make Parser constructor accept a client socket, add reading and writing methods for the socket to JavaParser. Parse main method sets up a server for accepting parse jobs from the crawler, and starts threads for each parse task.		vor 10 Jahren
bitshift	Mod:	vor 10 Jahren
docs	Update some documentation.	vor 10 Jahren
parsers/java	Make Parser implement runnable so parsing tasks can be started in separate threads. Make Parser constructor accept a client socket, add reading and writing methods for the socket to JavaParser. Parse main method sets up a server for accepting parse jobs from the crawler, and starts threads for each parse task.	vor 10 Jahren
static	Add assets/config module, SASS files, templates.	vor 10 Jahren
templates	Add assets/config module, SASS files, templates.	vor 10 Jahren
.gitignore	Fix errors in java parser, mostly casting issues. In Parse.java, set up a tcp server for communication with python processes. Builds with maven	vor 10 Jahren
LICENSE	Fix names in license.	vor 10 Jahren
README.md	Update some documentation.	vor 10 Jahren
app.py	Merge branch 'develop' of github.com:earwig/bitshift into develop	vor 10 Jahren
setup.py	Update some documentation.	vor 10 Jahren

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.

Releasing

Update __version__ in bitshift/__init__.py, version in setup.py, and version and release in docs/conf.py.