bitshift

битовый сдвиг

bitshift — это система семантического поиска исходного кода, разработанная Бенджамином Атталом, Беном Куртовичем и Северином Козаком. Этот README предназначен только для разработчиков. Для пользовательского обзора проекта:

• прочитайте нашу страницу о нас
• посмотрите наше демонстрационное видео

Филиалы

• master : рабочий, протестированный код с номером версии — без прямых коммитов; следует принимать слияния из develop только тогда, когда они готовы к выпуску
• develop : ветка интеграции с неизданным, но в основном функциональным кодом — прямые фиксации разрешены, но должны быть незначительными
• feature/* : отдельные компоненты проекта с непроверенным, вероятно, ужасно сломанным кодом - после завершения отделяются от develop и сливаются с ней.

Стиль

bitshift использует SASS для стилизации; скомпилируйте таблицы стилей в CSS с помощью sass --watch static/sass/:static/css .

Документация

Чтобы создать документацию, запустите make html из подкаталога docs . Затем вы можете просмотреть docs/build/html/index.html .

Чтобы автоматически обновить структуру документации API (необходимо при добавлении новых модулей или пакетов, но не при добавлении функций или изменении строк документации), запустите sphinx-apidoc -fo docs/source/api bitshift из корня проекта. Обратите внимание, что это приведет к отмене любых пользовательских изменений, внесенных в файлы в docs/source/api , поэтому вместо этого вы можете обновить их вручную.

Выпуск

• Обновите __version__ в bitshift/__init__.py , version в setup.py , а также version и release в docs/conf.py .