Added config example and updated README
This commit is contained in:
14
README.md
14
README.md
@@ -4,34 +4,28 @@ A simple daemon that automatically imports any libraries into KiCad. It currentl
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
An automated install script is planned but currently the repo needs to be cloned, built and installed manually
|
An automated install script is planned but currently the repo needs to be cloned, built and installed manually.
|
||||||
```
|
```
|
||||||
|
|
||||||
git clone https://git.h3cx.dev/h3cx/UniLoader.git
|
git clone https://git.h3cx.dev/h3cx/UniLoader.git
|
||||||
|
|
||||||
cd UniLoader
|
cd UniLoader
|
||||||
|
|
||||||
cargo build -r
|
cargo build -r
|
||||||
|
|
||||||
```
|
```
|
||||||
You will then find the binary under `target/release` you can run it manually or create a systemd service to automatically run it at boot
|
You will then find the binary under `target/release` you can run it manually or create a systemd service to automatically run it at boot.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
To get started you will need to set up your config, to do so create a config file
|
To get started you will need to set up your config, to do so create a config file. A full config file can be found in the config folder of this repo.
|
||||||
```
|
```
|
||||||
|
|
||||||
mkdir ~/.config/uniloader
|
mkdir ~/.config/uniloader
|
||||||
|
|
||||||
touch ~/.config/uniloader/config.toml
|
touch ~/.config/uniloader/config.toml
|
||||||
|
|
||||||
```
|
```
|
||||||
Then use your favorite text editor to open this config and paste in the minimal config
|
Then use your favorite text editor to open this config and paste in the minimal config.
|
||||||
```
|
```
|
||||||
|
|
||||||
[libraries]
|
[libraries]
|
||||||
path = "~/KiCad/libraries/"
|
path = "~/KiCad/libraries/"
|
||||||
|
|
||||||
```
|
```
|
||||||
Now that you have set this up, the application should be ready to go, just head over to your favorite library website and download any component.
|
Now that you have set this up, the application should be ready to go, just head over to your favorite library website and download any component.
|
||||||
|
|
||||||
|
|||||||
8
config/config_full.toml
Normal file
8
config/config_full.toml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
[libraries]
|
||||||
|
path = "/home/hector/KiCad/libraries/"
|
||||||
|
|
||||||
|
[options]
|
||||||
|
# Selectively enable and disable the importing of footprints and symbols
|
||||||
|
# symbols=true
|
||||||
|
# footprints=false
|
||||||
|
|
||||||
Reference in New Issue
Block a user