Compare commits

..

2 Commits

Author SHA1 Message Date
ronh a7018ac419 Updates README with output from --help argument 2023-03-11 19:31:02 -06:00
ronh a804694726 Updates README with setup/build/run instructions 2023-03-11 19:24:46 -06:00
+32 -2
View File
@@ -4,11 +4,41 @@ and public headers.
## Prerequisites ## Prerequisites
* Ubuntu 22.04 (or equivalent) * Ubuntu 22.04 (or equivalent)
* Python3 venv support installed (i.e. `sudo apt install python3-venv`) * Additional required packages:
* `g++`
* `cmake`
* `python3-venv`
## Setup ## Setup
Create a `python` virtual environment and install `conan`: Create a `python` virtual environment, install `conan`, and create a default profile:
```bash ```bash
python3 -m venv conan.venv python3 -m venv conan.venv
source conan.venv/bin/activate source conan.venv/bin/activate
pip install conan
conan profile detect
``` ```
## Building and running
1. To build, run:
```bash
./build.sh
```
2. The build command will generate a `deb` package in the `_packages` directory. To install (to
`/usr/local`) run:
```
sudo dpkg -i _packages/_packages/cppchallenge_1.0.0_*.deb
sudo ldconfig
```
__TODO__: The `sudo ldconfig` step should be added to the `deb` package `postinst` step...
3. To run:
```
$ cppchallenge
Hello World!
File name is: aname
$ cppchallenge --help
Just a simple 'hello'
Usage: cppchallenge [OPTIONS]
Options:
-h,--help Print this help message and exit
```