Skip to content
Mostly technical personal notes
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
docs
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
requirements.txt

README.md

ayazar's Notes

Build Status Documentation Status Uptime Robot status GitHub License PRs Welcome GitHub commit activity GitHub repo size in bytes

Welcome to source code repository of my personal notes.

I am an electronics engineer interested in computers. So expect that kind of content.

My main purpose is to collect my notes in one place. I prefer to share them publicly because I believe that this will lead creation of more up-to-date and more correct resource. Therefore, I would like to hear your feedback, your comments and corrections.

Reading Notes

Uptime Robot status Uptime Robot ratio (30 days)

https://notes.ayazar.com

Notes are compiled automatically and hosted by readthedocs.org

File Organization

Source code of the notes is under docs directory. Root directory holds some auxiliary files like this file.

Compiling Notes

In order to compile notes on your machine, first install Sphinx. Refer to document of Sphinx if you need help. Then cd to docs directory and run the following commands.

Windows Users

Cmd.exe

make.bat html

Powershell

.\make.bat html

Linux Users

Shell

make html

Above commands will generate docs/_build/html/index.html file. This is the front page of the notes. Open it with your favorite browser.

If you need to compile for PDF or different output format, please check Sphinx documentation.

Contributing

PRs Welcome

I will be happy if you help me to make these notes better. If you are not familiar with reStructuredText, compiling a Sphinx project git pull requests or Github then you can create New issue on Issues page to talk about your contribution, corrections, fixes, etc.

If you can modify the source files and create pull request, then please read CONTRIBUTING.md page.

License

GitHub License

SPDX-License-Identifier:CC-BY-SA-4.0

This project is licensed under CC-BY-SA-4.0 if otherwise stated. Check LICENSE for further information.

You can’t perform that action at this time.