Skip to content

Commit f6d9725

Browse files
committed
Unify readme files
Signed-off-by: Andrei Cipu <[email protected]>
1 parent 0d56c32 commit f6d9725

File tree

2 files changed

+23
-30
lines changed

2 files changed

+23
-30
lines changed

README.md

+23-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,26 @@
1-
## aws-nitro-enclaves-cli
1+
Nitro-cli
22

3-
Tooling for Nitro Enclave Management
3+
It contains a collection of tools and commands used for managing the lifecycle
4+
of Nitro Enclaves.
45

5-
## License
6+
Prerequisites:
7+
1. A working docker setup, follow https://docs.docker.com/install/overview/
8+
for details of how to install docker on your host.
9+
2. Install gcc, make, git.
610

7-
This library is licensed under the Apache 2.0 License.
11+
Driver information:
12+
The Nitro Enclaves device driver is currently at version 0.2. It is based on the
13+
kernel tree head commit b335e6094dff (tag: v0.2, origin/ne-driver-mainline-kernel,
14+
"nitro_enclaves: Add hrtimer support for polling") and supports out-of-tree driver builds.
15+
16+
How to install:
17+
1. Clone the repository.
18+
2. Set NITRO_CLI_INSTALL_DIR to the desired location, by default everything will be
19+
installed in build/install
20+
3. Run 'make nitro-cli && make vsock-proxy && make install'.
21+
4. Source the script ${NITRO_CLI_INSTALL_DIR}/etc/profile.d/nitro-cli-env.sh.
22+
5. [Optional] You could add ${NITRO_CLI_INSTALL_DIR}/etc/profile.d/nitro-cli-env.shenv.sh in you local shell configuration.
23+
6. You are now ready to go.
24+
25+
How to use nitro-cli:
26+
TODO: link to official AWS documentation

Readme.md

-26
This file was deleted.

0 commit comments

Comments
 (0)