diff --git a/.vuepress/public/troubleshooting-md/decompile-error.png b/.vuepress/public/troubleshooting-md/decompile-error.png new file mode 100644 index 0000000..8fa0f8c Binary files /dev/null and b/.vuepress/public/troubleshooting-md/decompile-error.png differ diff --git a/.vuepress/public/troubleshooting-md/invalid-parse.png b/.vuepress/public/troubleshooting-md/invalid-parse.png new file mode 100644 index 0000000..04a6807 Binary files /dev/null and b/.vuepress/public/troubleshooting-md/invalid-parse.png differ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a2ae5c..e6e4c2f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,17 +39,17 @@ Some guidelines when contributing via PRs: ### How to Contribute -Best way to test your commits and make sure they are formatted correctly is downloading `nodejs` and getting the [gitbook-cli](https://github.com/GitbookIO/gitbook-cli) and [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) tools. When you run `gitbook serve`, it will set up a local webserver which you can connect to view the changes you made. `markdownlint *` will throw any errors at you about formatting as well, and `markdownlint -f *` will attempt to fix these. +Best way to test your commits and make sure they are formatted correctly is downloading `nodejs` and `yarn` then getting the VuePress and [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) tools. When you run `yarn dev`, it will set up a local webserver which you can connect to view the changes you made. `markdownlint *` will throw any errors at you about formatting as well, and `markdownlint -f *` will attempt to fix these. * [Fork this repo](https://github.com/dortania/Getting-Started-With-ACPI/fork/) * Install the required tools: + * `brew install yarn` * `npm install -g markdownlint-cli` - * `npm install -g gitbook-cli` * Make your changes. * Build the site: - * `gitbook install` (To install all the required gitbook plugins) - * `gitbook serve` (Preview the site) - * Can be found at `http://localhost:4000` + * `yarn install` (To install all the required plugins) + * `yarn dev` (Preview the site) + * Can be found at `http://localhost:8080` * Check markdown format: * `markdownlint -f *` (To fix any potential issues) diff --git a/troubleshooting.md b/troubleshooting.md index 26cd820..f73aa42 100644 --- a/troubleshooting.md +++ b/troubleshooting.md @@ -51,7 +51,7 @@ iasl * [insert all ACPI files here] ## Decompiling Error -![](../images/troubleshooting-md/decompile-error.png) +![](/troubleshooting-md/decompile-error.png) ``` Loading Acpi table from file iASLAwjHrs.aml @@ -63,12 +63,12 @@ This is a common error on DSDTs that have methods that aren't supported by maciA ## Invalid character (0x3D), expecting ASL keyword or name -![](../images/troubleshooting-md/invalid-parse.png) +![](/troubleshooting-md/invalid-parse.png) Similar to the above error, you're running an outdated copy of maciASL. Make sure you're using the latest from Acidanthera's repo: [maciASL](https://github.com/acidanthera/MaciASL/releases) ## Syntax error, unexpected PARSEOP_ONE, expecting '(' -![](../images/troubleshooting-md/invalid-parse.png) +![](/troubleshooting-md/invalid-parse.png) Similar to the above 2 errors, you're running an outdated copy of maciASL. Make sure you're using the latest from Acidanthera's repo: [maciASL](https://github.com/acidanthera/MaciASL/releases)