Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add build instructions including the list of dependencies and improve the docs #3

Open
tukusejssirs opened this issue Jun 8, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@tukusejssirs
Copy link
Contributor

tukusejssirs commented Jun 8, 2021

As I have never ever build or used C# code, I’ve searched the Internet to gather the build instructions in order to test this piece of awesome code. I still miss some instructions.

I mean something like this (note that these instructions are for Linux, specifically tested on Fedora 32; this is mostly already done):

# Install dotnet 3.1
# Note: The code does not work with 5.0, which might be a good idea to improve.
sudo dnf -y install dotnet-sdk-3.1 openssl

# Clone the repository
# Note: You could also use https://github.com/Ladder99/fanuc-driver.git.
git clone --recurse-submodules [email protected]:Ladder99/fanuc-driver.git

# Build
dotnet build /nowarn:CS0618 /nowarn:CS8632 /nowarn:CS1998 -p:DefineConstants=LINUX64 fanuc-driver/fanuc/fanuc.csproj

# Run
dotnet run /nowarn:CS0618 /nowarn:CS8632 /nowarn:CS1998 fanuc-driver/fanuc/fanuc.csproj

# Or rather this one?
fanuc-driver/fanuc/bin/Debug/netcoreapp3.1/fanuc

It would be awesome if the contents of config.yml (it is already done) and nlog.config would be documented, as currently I need to try what some of the configuration options need to do.

Also the command-line options (like --nlog or --config) should be documented.

@tukusejssirs tukusejssirs changed the title Add build instructions including the list of dependencies Add build instructions including the list of dependencies and improve the docs Jun 8, 2021
@MRIIOT MRIIOT added the documentation Improvements or additions to documentation label Jun 9, 2021
@tukusejssirs
Copy link
Contributor Author

This is mostly done in the docs now. A related issue I created today (as I’ve forgotten about this issue) is #29.

We might close this issue, although commands like cd ~ should be removed from the instructions. I’d rather use a variable with path where fanuc-driver would be cloned and the user could easily change it to whatever they want.

@MRIIOT MRIIOT added this to the 0.6 milestone Oct 13, 2022
@MRIIOT MRIIOT modified the milestones: 0.6, 0.7 Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants