[Documentation] README.md needs review

[casasfernando]

I found a couple of issues in the README.md file for the repo while trying to learn how to build the Android app on Linux to test this.

1. In the Installation I found a broken link in official React Native Getting Started guide that points to a page that is not found anymore.

2. In the Installation section you can read the following:

Ensure that you're using NodeJS 14 or newer on OSX. Android projects can be built and tested on Linux and Windows, but these platforms are not officially supported.

And a few lines below you can read this:

Important note about Node.js support: Development for this project should be performed on Node version 8. Although it may work on versions 6 and newer, we will not be supporting issues raised for these versions. Similarly, we do not currently support NodeJS version 9.

This is confusing for new people like me and think the bug was introduced in commit https://github.com/buttercup/buttercup-mobile/commit/d339e6f849ec43d65883668878086da890f81b10

I guess the last note needs to be removed or updated to also state that NodeJS 14 needs to be used.

3. In the section Building an APK in step 2 the command npm run build:android doesn't work. It seems the target doesn't exist or is called differently in current code:

root@300533dccb18:~/buttercup-mobile# npm run build:android
npm ERR! missing script: build:android
npm ERR! 
npm ERR! Did you mean one of these?
npm ERR!     android
npm ERR!     build:ios

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2022-02-25T17_26_10_561Z-debug.log

The workaround I used was to manually run react-native bundle --entry-file='index.js' --bundle-output='./android/main.jsbundle' --dev=false --platform='android'.

Thanks.

[perry-mitchell]

Thanks for this, I'd consider a PR fixing these points of course..

[casasfernando]

I will create a PR for 1 and 2 but for 3 I don’t have a clue how to properly fix it yet (to have a working build:android). Android, NodeJS, React, the build system are all new to me… but I will look into it since it’s probably an easy one. I will be more than happy if I manage to build an APK during the weekend! 😅

[casasfernando]

@perry-mitchell I'm preparing the PR. Regarding point 2, what do you want to do about this note?

Important note about Node.js support: Development for this project should be performed on Node version 8. Although it may work on versions 6 and newer, we will not be supporting issues raised for these versions. Similarly, we do not currently support NodeJS version 9.

Should I remove it or updated to something like the below?

Important note about Node.js support: Development for this project should be performed on Node version 14. Although it may work on versions 6 and newer, we will not be supporting issues raised for these versions. Similarly, we do not currently support NodeJS version 15 or newer.

I'm not familiar with the code and I'm not the project owner so it's up to you to decide what is supported and what's not. :) Let me know what you decide and I will update the documentation accordingly.

Thanks.