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.

Sign up for GitHub

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

Jump to bottom

Update command-reference.md #291

Merged
merged 9 commits into from
Nov 3, 2023
Merged

Update command-reference.md #291

merged 9 commits into from
Nov 3, 2023

Conversation

chenzhitong
Copy link
Member

Fix #290

@lock9
Copy link
Contributor

lock9 commented Nov 2, 2023 •
edited
Loading

Hi @chenzhitong ,
I've noticed you updated the installation instructions. These will work but it's not how it should be used. Neo-express requires no installation. It can, and should, be shipped as a standalone application. I don't think that asking people to install the .NET SDK is reasonable. We can embed the runtime in the application.

@chenzhitong
Copy link
Member Author

chenzhitong commented Nov 3, 2023 •
edited
Loading

Hi @chenzhitong , I've noticed you updated the installation instructions. These will work but it's not how it should be used. Neo-express requires no installation. It can, and should, be shipped as a standalone application. I don't think that asking people to install the .NET SDK is reasonable. We can embed the runtime in the application.

I copied the installation instructions directly from the readme.md.
Isn't neo-express installed through dotnet tools?
And the installation instructions doesn't say anything about installing the SDK.

@lock9
Copy link
Contributor

lock9 commented Nov 3, 2023

Isn't neo-express installed through dotnet tools?
And the installation instructions doesn't say anything about installing the SDK.

dotnet tools is part of the .NET SDK. We can continue to distribute it using it. However, neo-express can be compiled and shipped as a standalone app that doesn't require external tools (like dotnet tools).
It may be fine to update the installation guide now, but be aware that we need to change the distribution method.

@chenzhitong
Copy link
Member Author

I'll revert the installation instructions first and then submit it after neo-express is compiled into a standalone application

lock9
lock9 reviewed Nov 3, 2023
View reviewed changes
Copy link
Contributor

@lock9 lock9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw some differences in the indentation, but everything else looks fine. By the way, the next release has an 'update' command that needs to be described here. Let's leave that for later.

docs/command-reference.md Outdated
-p|--password <PASSWORD> password to use for NEP-2/NEP-6 sender
-i|--input <INPUT> Path to neo-express data file
-t|--trace Enable contract execution tracing
-j|--json Output as JSON
<Policy>: Policy to set
Allowed values are: GasPerBlock, MinimumDeploymentFee, CandidateRegistrationFee,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some differences in indentation.

docs/command-reference.md Outdated
-p|--password <PASSWORD> password to use for NEP-2/NEP-6 sender
-i|--input <INPUT> Path to neo-express data file
-t|--trace Enable contract execution tracing
-j|--json Output as JSON
<Source>: Source of policy values. Must be local policy settings JSON file or the URL of Neo JSON-RPC
Node
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some differences in indentation.

@lock9
Copy link
Contributor

lock9 commented Nov 3, 2023 •
edited
Loading

@chenzhitong I think your PR won't pass the checks. One alternative is to send the PR to the 3.6 branch (https://github.com/neo-project/neo-express/pull/286/files). If you do that, maybe you could also include the 'update' command documentation? 😅
The smart contract will need to have a method with this signature:
def update(nef: bytes, manifest: str): (python)

@lock9
Copy link
Contributor

lock9 commented Nov 3, 2023

Hi @Liaojinghui, can you merge this PR? Thanks

@Jim8y Jim8y merged commit b78a4b6 into neo-project:master Nov 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lock9 lock9 lock9 approved these changes

@Jim8y Jim8y Jim8y approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Inappropriate command description documentation
3 participants
@chenzhitong @lock9 @Jim8y