DataHearth
/
config-mapper
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Releases 5 Activity

chore(doc): update readme

This commit is contained in:
DataHearth 2022-06-02 18:02:33 +02:00
parent 07e187e528
commit 3a7210bc69
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -56,7 +56,7 @@ config-mapper save
All defined files and folders will be copied inside your repository.
If you want to exclude one part of your configuration file (files, folders), you can use these flags to ignore them `--disable-files` `--disable-folders`. Note, package managers are disable by default. You can enable this option using the `--pkgs` flag.
If you want to exclude one part of your configuration file (files, folders), you can use these flags to ignore them `--disable-files` `--disable-folders`. Note, package managers are disable by default. You can enable this option using the `--pkgs` flag.
You can also exclude files and folders from a given directory with a `.gitignore` like file named `.ignore`. Put it in the root directory of an included folder and add relative path to exclude (does not support glob for now). E.g:
@ -73,6 +73,7 @@ drwxr-xr-x - antoine 1 Jun 20:27 └── foo
```
`.ignore` content:
```
# bar file will be ignored
foo/bar
@ -130,7 +131,7 @@ The same ignore flags are used in the `save` command.
## TO-DO
- [X] add `.ignore` file to ignore content inside directory
- [x] add `.ignore` file to ignore content inside directory
- [ ] optimisation over speed and memory
- [ ] load configuration though SSH
- [ ] save configuration though SSH
@ -145,3 +146,6 @@ The same ignore flags are used in the `save` command.
Resolved by create a new primary key based on GitHub new GIT SSH standards ([issue](https://github.com/go-git/go-git/issues/411))
- Cloning from GitHub with `https BasicAuth` and 2FA activated: `authentication required`
Resolved by creating an access token and set it as password in configuration
- WSL might have a rough time with opened files by `homebrew` and throwing `Error: too many open files`.
[This thread](https://github.com/Homebrew/linuxbrew-core/issues/21139) discuss about this issue.
The workaround seems to be settings the filesystem limit (`ulimit -Hn && ulimit -Sn`) to the maximum value (which was 4096 on my machine).

2
go.mod
View File

@ -7,6 +7,7 @@ require (
github.com/spf13/cobra v1.3.0
github.com/spf13/viper v1.10.1
gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
github.com/fatih/color v1.13.0
)
require (
@ -14,7 +15,6 @@ require (
github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7 // indirect
github.com/acomagu/bufpipe v1.0.3 // indirect
github.com/emirpasic/gods v1.12.0 // indirect
github.com/fatih/color v1.13.0
github.com/fsnotify/fsnotify v1.5.1 // indirect
github.com/go-git/gcfg v1.5.0 // indirect
github.com/go-git/go-billy/v5 v5.3.1 // indirect