Skip to content

Commit

Permalink
Update development docs to match cnquery
Browse files Browse the repository at this point in the history
Move everything to the dev doc and link to that.

Signed-off-by: Tim Smith <tsmith84@gmail.com>
  • Loading branch information
tas50 committed Oct 12, 2022
1 parent 44cef0a commit eebff1e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 31 deletions.
27 changes: 2 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,36 +178,13 @@ Explore our:
## Community and support
Our goal is to secure all layers of your infrastructure. If you need support, or want to get involved with the development of `cnspec`, join our [community](https://github.com/orgs/mondoohq/discussions) today and let’s grow it together!
## Troubleshooting
### Private repository access
If you see this error:
```
fatal: could not read Username for 'https://github.com': terminal prompts disabled
Confirm the import path was entered correctly.
```
It is caused by the repository currently being private. It'll be publish soon, but while it's still private, you need to configure your gitconfig to use SSH to download the repo:
```
[url "ssh://git@github.com/"]
insteadOf = https://github.com/
```
Our goal is to secure all layers of your infrastructure. If you need support, or want to get involved with the development of `cnspec`, join our [community](https://github.com/orgs/mondoohq/discussions) today and let’s grow it together!
## Development
We love emojis in our commits. These are their meanings:
🛑 breaking 🐛 bugfix 🧹 cleanup/internals 📄 docs
✨⭐🌟🎉 smaller or larger features 🐎 race condition
🌙 MQL 🌈 visual 🍏 fix tests 🎫 auth 🦅 falcon 🐳 container
See our [Development Documentation](docs/development.md) for information on building and contributing to cnspec.
## Legal
- **Copyright:** 2018-2022, Mondoo Inc, proprietary
- **Authors:** Christoph Hartmann, Dominik Richter
23 changes: 17 additions & 6 deletions docs/development.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
### Dependencies
# Development

## Prerequisites
## Building

### Prerequisites

Before building from source, be sure to install:

Expand Down Expand Up @@ -28,14 +30,13 @@ If `go` is not installed or an older version exists, follow instructions on [the

3. Build and install

#### Unix-like systems
#### Unix-like systems
```sh
# To install `cnspec` using Go into the $GOBIN directory:
export GOPRIVATE="github.com/mondoohq,go.mondoo.com"
make cnspec/install
```

## Develop cnspec
## Developing cnspec

Whenever you change protos or other auto-generated files, you must regenerate files for the compiler. To do this, be sure you have the necessary tools installed (such as protobuf):

Expand All @@ -61,4 +62,14 @@ Then, whenever you make changes, just run:
make cnspec/generate
```

This generates and updates all required files for the build. Now you can `make cnspec/install` again as outlined above.
This generates and updates all required files for the build. At this point you can `make cnspec/install` again as outlined above.

## Contributing Changes

### Marking PRs with Emojis

We love emojis in our commits. These are their meanings:

🛑 breaking 🐛 bugfix 🧹 cleanup/internals 📄 docs
✨⭐🌟🎉 smaller or larger features 🐎 race condition
🌙 MQL 🌈 visual 🍏 fix tests 🎫 auth 🦅 falcon 🐳 container

0 comments on commit eebff1e

Please sign in to comment.