Dax89 / automaton.nvim

VSCode-Like Workspace Configuration Manager
MIT License
36 stars 3 forks source link

Documentation needed #5

Closed lobneroO closed 4 months ago

lobneroO commented 4 months ago

The documentation is a bit lacking, it's hard to use the plugin.

E.g. what is the difference between Automaton Create and Automaton Init? Why does create -> enter name "xyz" give a prompt of "xyz/home/user"?

I tried to initialize a workspace in one of my rust projects and it didn't give an error, but I don't see the .json files. Do I have to manually create them? What did init do then?

Dax89 commented 4 months ago

There is some basic documentation here: https://github.com/Dax89/automaton.nvim/wiki

Here you can find some informations about a workspace: https://github.com/Dax89/automaton.nvim/wiki/Workspace

lobneroO commented 4 months ago

Ah, that latter link was what I was looking for, thank you. I'll see if this already sufficient. I think it would be beneficial to link to that page in this repositories readme

Dax89 commented 4 months ago

I have checked the source code, Automaton init creates a workspace in the folder that belongs to the currently open file.

So if you have:

foo/
  bar/
    main.rs

And you have main.rs open, the result is:

foo/
  bar/
    .automaton/ <==== this is where all workspace data is stored
    main.rs