summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)AuthorFilesLines
2021-11-03README: update setup after machine cleanupsPatrick Williams1-13/+10
Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: I3daacc34af1b628f2f1e279a45e1e13bf06ac746
2021-10-18Update setup script information in the README.mdKonstantin Aladyshev1-18/+14
Update information about all the possible target machines. Remove extra information about 'evb-ast2500' target as it no longer needs a special handling. Signed-off-by: Konstantin Aladyshev <aladyshev22@gmail.com> Change-Id: Id05bb976cc339d62bcf6433251bd8b0f8787ccbd
2021-09-01README.md: Update name list of Technical Steering CommitteeGilbert Chen1-1/+1
Replace Supreeth Venkatesh with Samer El-Haj-Mahmound who represents Arm now. Signed-off-by: Gilbert Chen <gilbert.chen@arm.com> Change-Id: I3f0cfb8a130cf77228a0bf6d5b904526ef832e01
2021-05-28README: Don't specify build directory in setup exampleAndrew Jeffery1-1/+1
Stop specifying the build directory in the example so people don't trip over the incomprehensible errors that occur when they eventually do change platform. Change-Id: Id67d74169cac69be99aca5ecb3d4eeac37dcef44 Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
2021-05-28README: Improve clarity of the opening descriptionAndrew Jeffery1-6/+4
"can be described as" sounds a lot like Chris Austen having a chat with someone over a beer. To the extent that Yocto is a Linux distribution (which it isn't, but that's somewhat of a detail), OpenBMC is also a distribution. Change-Id: I5e72c3b357441a41c525b843bc1768d5946b645b Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
2021-04-12README: Remove witherspoon-128 and reorder itAdriana Kobylak1-10/+10
The witherspoon-128 machine was removed with openbmc/openbmc commit 40c2946. Remove it from the README and re-arrange the machine names alphabetically so it's easier to find and maintain the names. Change-Id: I02a88bc85167b42622c2c3db8e4e3b43db4444e2 Signed-off-by: Adriana Kobylak <anoo@us.ibm.com>
2021-04-08ibm: Create p10bmc build targetAdriana Kobylak1-1/+1
Replace rainier with p10bmc as build target. Keep the rainier.conf as a symlink to p10bmc.conf to allow the transition. Remove the rainier.conf and the machine override from p10bmc.conf in a later commit to complete the replacement. Tested: Built rainier and p10bmc and checked for some files/service units to exist on both. Change-Id: Ic8c8c6ffbc3507fbd9c692da259e37ae695359a6 Signed-off-by: Adriana Kobylak <anoo@us.ibm.com>
2020-12-01Replace IRC with DiscordGunnar Mills1-2/+1
Discord has more users. IRC traffic has ground to a halt. No real objection to https://lists.ozlabs.org/pipermail/openbmc/2020-November/023984.html Removed IRC and Riot from the README and replaced IRC in other places. Change-Id: I7124b11320f6c31e9e0a2aead35274690ff0f908 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2020-11-16README: suggest Discord over IRC for supportPatrick Williams1-3/+3
Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: I7af13404d6e5101ac3d9d05d5f7d1c1d4e550d9d
2020-11-16README: Add Discord invite linkPatrick Williams1-0/+1
Add invite link to Discord per announcement email at https://lore.kernel.org/openbmc/20201112145740.GB4495@heinlein/ Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: Iedde67dc94d071206688bece588ac2615bbb9f01
2020-08-03README: Update the usage of setup scriptLei YU1-2/+2
The usage of setup script in README is missing the arguments, add them so it is more clear how the script is called. Before the script, the default build directory is `build`, so update the example of romulus build to specify the `build` directory. Otherwise, each machine has its own build directory. They do not share the downloads dir or the sstate dir. Signed-off-by: Lei YU <yulei.sh@bytedance.com> Change-Id: I21fcb1a133941fbbff80a33a250ece687622477b
2020-08-03README: Fix evb-ast2500 configLei YU1-0/+8
The evb-ast2500 config by `. setup` command was broken due to duplicated machine config. Add a special note about how to manually specify the machine config to setup the build. Signed-off-by: Lei YU <yulei.sh@bytedance.com> Change-Id: Ifad02bef1c8c5246494adcc3a8a4b6aaa974633b
2020-07-15readme: Point to jenkins.openbmc.orgAndrew Jeffery1-1/+1
Remove the reference to openpower.xyz, as we've shifted domains. Change-Id: I2c14852691e1afec2ab88ae960a6ae623a3bdc0e Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
2020-05-29Update README.md to describe setup scriptAlexander Amelkin1-18/+28
The `setup` script is there for quite a while but is still not described in the README.md, so the documentation teaches the users how to set up the environment the hard way. This commit makes it easier for the newcomers to set up the build environment. Change-Id: I1901273246567ff2c211edb251f65106263daf6f Signed-off-by: Alexander Amelkin <a.amelkin@yadro.com>
2020-01-15README: Fix TSC list mistakeGunnar Mills1-0/+1
2b90a9f2 missed a name on the TSC list. This commit fixes that mistake. The TSC list is moving to the openbmc/openbmc README because the docs README is becoming specific to the docs repo and the openbmc/openbmc README is for more general project information since the openbmc/openbmc README is most likely the first landing spot of anyone new to the project. Change-Id: I8884df9e7abc05d4551fe745dfb729c7b7dad0d8 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2020-01-09Move TSC information to openbmc/openbmcGunnar Mills1-0/+10
This commit adds the TSC (Technical Steering Committee) info to the openbmc/openbmc README. As suggested in and partially implemented in https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/28107 the docs README is specific to the docs repo and the openbmc/openbmc README is for more general project information since the openbmc/openbmc README is most likely the first landing spot of anyone new to the project. Change-Id: I539357bd78dbad39bda874b68a4acb587ecb5595 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2020-01-09README: Move complete featuresGunnar Mills1-2/+2
User management and Virtual media are done. Change-Id: Ided3ed088cbcfadf9c9d94af5667977ebbb27246 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2020-01-09Avoid opening issues for questionsGunnar Mills1-1/+2
Clarify that users should not open issues for questions. There has been a fair amount of issues opened for general questions, this aims to cut back on that. Change-Id: I1048ca9c1ff801789ae7c61ecd8caed4103e4eb3 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2019-10-29Point new users at development tutorialsAndrew Geissler1-0/+6
Change-Id: Iad7c66387dc12bdae68b0ccf221cad7db5ff20d9 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
2019-10-29Point users at romulus image when first buildingAndrew Geissler1-2/+2
Romulus is what OpenBMC uses for its CI environment so is where new users should be pointed at when first trying it out Change-Id: I1de412cef5915b955bd0c874a396b2b59e8fcf57 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
2019-10-16Create questions section in READMEAndrew Geissler1-0/+13
Getting lots of questions for a variety of topics in a variety of locations. Clarify where users should look and post their questions. Change-Id: I06f497e23f50abab4130effb883dc3d91935d21f Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
2019-05-03README: Document additional required Fedora dependenciesAndrew Jeffery1-1/+2
Resolves openbmc/openbmc#3404 Change-Id: Iaf59bbe6bcc3c30a6e90ebd706780c7c28873c9c Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
2019-03-05Docs: Update featuresJoseph Reynolds1-22/+15
This updates the list of OpenBMC features and links to the feature TOC in the docs repository. Tested: via copy/paste into: https://dillinger.io Change-Id: I3c9fdbb0fb87b3524550ee95ae7e37f623885bed Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>
2018-12-17README: Remove reference to OCC from feature listAndrew Jeffery1-1/+0
The On-Chip Controller is a Power-specific item while the rest of the list generalises over multiple host architectures. Change-Id: I56e0b5c65615aa416391a29630b5d0a8d56960ec Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
2018-10-30Add Romulus to examples in READMEAndrew Geissler1-0/+1
Recent documents use Romulus as the example platform for getting developers up to speed on developing for OpenBMC: https://github.com/openbmc/docs/tree/master/development Romulus was used because it's used by CI for every job, therefore being the most stable and supported. Change-Id: Icaac937696305f6c9131b2063954cc523b6d2df5 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
2018-10-06Update README.md for Fedora 28, fixing missing build-depStewart Smith1-2/+2
Change-Id: Iaa29eb3e523548dd746c366f318a67e14e3683f7 Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
2018-08-23[Subtree] Bring openbmc machines to top levelDave Cobbley1-8/+6
The new subtree model brings the subtrees up from the openbmc-machines layer. Change-Id: I58a03ae1be374bc79ae1438e65e888375d12d0c0 Signed-off-by: Dave Cobbley <david.j.cobbley@linux.intel.com> Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
2018-07-25Make CONTRIBUTING.md all caps as per the CharterAlexander Amelkin1-1/+1
According to the official Charter at https://www.openbmc.org/wp-content/uploads/sites/62/2018/03/charter_openbmc_02142018.pdf the file must be named literally `CONTRIBUTING`. That is, all caps. This has been discussed in review comments for https://gerrit.openbmc-project.xyz/9948 This commit accompanies the corresponding changes to the docs repository, see https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/10807 Change-Id: I320b9a4b18d4e4a741cbcb29fff8475994493ae6 Signed-off-by: Alexander Amelkin <a.amelkin@yadro.com>
2018-04-04Remove Barreleye from READMEGunnar Mills1-1/+0
Barreleye is no longer a supported machine. Removed a reference to Barreleye. Change-Id: I6c0fc792cf1a09c29836ffbc235d4775de4f7b12 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2018-01-17OpenBMC README.md fixesGunnar Mills1-24/+29
Made grammar fixes, style fixes, and corrected incorrect information in OpenBMC README. Also, added several links. Change-Id: Iafc0974cb53c6be90357265b8842725950d99acd Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
2017-06-21Add supported features list to READMEcausten1-0/+33
People have been asking for a list of things OpenBMC supports. This is a list of operator useable features along with items that are in progress and additional features we are looking for support. Change-Id: I58ceb6aa32bbf68c190ba0eac5419979fbe9aa63 Signed-off-by: Chris Austen <austenc@us.ibm.com>
2017-03-30README: Fix markdown linksPatrick Williams1-6/+6
Change-Id: I9a37b996eb62b90653c5c9b20326b91a94cdca54 Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
2017-02-01Additional details to README.mdChris Austen1-13/+89
Spruce up the README file to include high level information about 1. Who we are 2. How to build 3. What we do 4. How to seek help Change-Id: I8a515d291884749b2cd5dca5f67b3c6a63683975 Signed-off-by: Chris Austen <austenc@us.ibm.com>
2016-01-22Adding Fedora 23 requirements to READMEAntony Messerli1-6/+8
2015-12-15Added ubuntu dependencies to readmekenneth-wilke1-1/+7
2015-11-11add: build status on main pageChris Smart1-0/+4
2015-09-16Environment helper utility.Patrick Williams1-0/+12
2015-09-09Create empty repository.Patrick Williams1-0/+0
generated by cgit v1.2.3 (git 2.39.0) at 2024-06-26 02:09:57 +0300