Ver código fonte

Merge pull request #13 from openfheorg/Oliveira_README

first readme with building instructions
Rener Oliveira 1 ano atrás
pai
commit
de5d2c366e
1 arquivos alterados com 30 adições e 0 exclusões
  1. 30 0
      README.md

+ 30 - 0
README.md

@@ -0,0 +1,30 @@
+# [Work in Progress] Official Python wrapper for OpenFHE
+
+## Building
+
+Before building, make sure you have the following dependencies installed:
+
+- [CMake](https://cmake.org/)
+- [Python 3.6+](https://www.python.org/)
+- [pybind11](pybind11.readthedocs.io)
+- [OpenFHE](https://github.com/openfheorg/openfhe-development)
+
+### Linux
+
+With all the dependencies setted up, clone the repository, open a terminal in the repo folder and run the following commands:
+
+```bash
+mkdir build
+cd build
+cmake ..
+make
+make install
+```
+Obs.: If the last command fails, try running it with sudo.
+
+After that, you can run the examples in the src/pke/examples folder:
+
+```bash
+python src/pke/examples/simple-integers.py
+```
+